<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>RedirectControllableEntityProviderMock xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../../../../apidocs/org/sakaiproject/entitybus/mocks/RedirectControllableEntityProviderMock.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <em>/**<em>*</em></em>
<a name="2" href="#2">2</a>   <em> * $Id: RedirectControllableEntityProviderMock.html 12 2009-01-29 12:00:24Z azeckoski $</em>
<a name="3" href="#3">3</a>   <em> * $URL: http://entitybus.googlecode.com/svn/maven/site/entitybus-mocks/xref/org/sakaiproject/entitybus/mocks/RedirectControllableEntityProviderMock.html $</em>
<a name="4" href="#4">4</a>   <em> * RESTfulEntityProviderMock.java - entity-broker - Apr 9, 2008 10:31:13 AM - azeckoski</em>
<a name="5" href="#5">5</a>   <em> **************************************************************************</em>
<a name="6" href="#6">6</a>   <em> * Copyright (c) 2008 Sakai Foundation</em>
<a name="7" href="#7">7</a>   <em> *</em>
<a name="8" href="#8">8</a>   <em> * Licensed under the Educational Community License, Version 2.0 (the "License");</em>
<a name="9" href="#9">9</a>   <em> * you may not use this file except in compliance with the License.</em>
<a name="10" href="#10">10</a>  <em> * You may obtain a copy of the License at</em>
<a name="11" href="#11">11</a>  <em> *</em>
<a name="12" href="#12">12</a>  <em> *       <a href="http://www.osedu.org/licenses/ECL-2.0" target="alexandria_uri">http://www.osedu.org/licenses/ECL-2.0</a></em>
<a name="13" href="#13">13</a>  <em> *</em>
<a name="14" href="#14">14</a>  <em> * Unless required by applicable law or agreed to in writing, software</em>
<a name="15" href="#15">15</a>  <em> * distributed under the License is distributed on an "AS IS" BASIS,</em>
<a name="16" href="#16">16</a>  <em> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a name="17" href="#17">17</a>  <em> * See the License for the specific language governing permissions and</em>
<a name="18" href="#18">18</a>  <em> * limitations under the License.</em>
<a name="19" href="#19">19</a>  <em> */</em>
<a name="20" href="#20">20</a>  
<a name="21" href="#21">21</a>  <strong>package</strong> org.sakaiproject.entitybus.mocks;
<a name="22" href="#22">22</a>  
<a name="23" href="#23">23</a>  <strong>import</strong> java.util.Map;
<a name="24" href="#24">24</a>  
<a name="25" href="#25">25</a>  <strong>import</strong> org.sakaiproject.entitybus.EntityView;
<a name="26" href="#26">26</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.CoreEntityProvider;
<a name="27" href="#27">27</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.annotations.EntityURLRedirect;
<a name="28" href="#28">28</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.capabilities.CRUDable;
<a name="29" href="#29">29</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.capabilities.CollectionResolvable;
<a name="30" href="#30">30</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.capabilities.RESTful;
<a name="31" href="#31">31</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.capabilities.Resolvable;
<a name="32" href="#32">32</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.capabilities.RedirectControllable;
<a name="33" href="#33">33</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.extension.Formats;
<a name="34" href="#34">34</a>  <strong>import</strong> org.sakaiproject.entitybus.mocks.data.MyEntity;
<a name="35" href="#35">35</a>  
<a name="36" href="#36">36</a>  
<a name="37" href="#37">37</a>  <em>/**<em>*</em></em>
<a name="38" href="#38">38</a>  <em> * Stub class to make it possible to test the {@link RedirectControllable} capabilities, will perform like the</em>
<a name="39" href="#39">39</a>  <em> * actual class so it can be reliably used for testing&lt;br/> </em>
<a name="40" href="#40">40</a>  <em> * Will perform all {@link CRUDable} operations as well as allowing for internal data output processing&lt;br/></em>
<a name="41" href="#41">41</a>  <em> * Returns {@link MyEntity} objects&lt;br/></em>
<a name="42" href="#42">42</a>  <em> * Allows for testing {@link Resolvable} and {@link CollectionResolvable} as well, returns 2 {@link MyEntity} objects </em>
<a name="43" href="#43">43</a>  <em> * if no search restrictions, 1 if "stuff" property is set, none if other properties are set</em>
<a name="44" href="#44">44</a>  <em> * </em>
<a name="45" href="#45">45</a>  <em> * @author Aaron Zeckoski (aaron@caret.cam.ac.uk)</em>
<a name="46" href="#46">46</a>  <em> */</em>
<a name="47" href="#47">47</a>  <strong>public</strong> <strong>class</strong> <a href="../../../../org/sakaiproject/entitybus/mocks/RedirectControllableEntityProviderMock.html">RedirectControllableEntityProviderMock</a> <strong>extends</strong> <a href="../../../../org/sakaiproject/entitybus/mocks/RESTfulEntityProviderMock.html">RESTfulEntityProviderMock</a> implements CoreEntityProvider, RESTful, 
<a name="48" href="#48">48</a>        RedirectControllable {
<a name="49" href="#49">49</a>  
<a name="50" href="#50">50</a>     <strong>public</strong> <a href="../../../../org/sakaiproject/entitybus/mocks/RedirectControllableEntityProviderMock.html">RedirectControllableEntityProviderMock</a>(String prefix, String[] ids) {
<a name="51" href="#51">51</a>        <strong>super</strong>(prefix, ids);
<a name="52" href="#52">52</a>     }
<a name="53" href="#53">53</a>  
<a name="54" href="#54">54</a>     <strong>public</strong> String[] templates = <strong>new</strong> String[] {
<a name="55" href="#55">55</a>           <span class="string">"/{prefix}/site/{siteId}/user/{userId}"</span>, 
<a name="56" href="#56">56</a>           <span class="string">"/{prefix}/{id}/{thing}/go"</span>, 
<a name="57" href="#57">57</a>           <span class="string">"/{prefix}/xml/{id}"</span> 
<a name="58" href="#58">58</a>     };
<a name="59" href="#59">59</a>     <strong>public</strong> String[] defineHandledTemplatePatterns() {
<a name="60" href="#60">60</a>        <strong>return</strong> templates;
<a name="61" href="#61">61</a>     }
<a name="62" href="#62">62</a>  
<a name="63" href="#63">63</a>     <em class="comment">// TODO handle infinite redirects</em>
<a name="64" href="#64">64</a>     <strong>public</strong> String handleRedirects(String matchedTemplate, String incomingURL,
<a name="65" href="#65">65</a>           String[] incomingSegments, Map&lt;String, String> values) {
<a name="66" href="#66">66</a>        String redirectURL = <strong>null</strong>;
<a name="67" href="#67">67</a>        <strong>if</strong> (matchedTemplate.equals(templates[0])) {
<a name="68" href="#68">68</a>           redirectURL = values.get(EntityView.PREFIX) + EntityView.SEPARATOR 
<a name="69" href="#69">69</a>              + <span class="string">"siteuser?site="</span> + values.get(<span class="string">"siteId"</span>) + <span class="string">"&amp;user="</span> + values.get(<span class="string">"userId"</span>);
<a name="70" href="#70">70</a>        } <strong>else</strong> <strong>if</strong> (matchedTemplate.equals(templates[1])) {
<a name="71" href="#71">71</a>           redirectURL = <span class="string">"http://caret.cam.ac.uk/?prefix="</span> + values.get(EntityView.PREFIX) + <span class="string">"&amp;thing="</span> + values.get(<span class="string">"thing"</span>);
<a name="72" href="#72">72</a>        } <strong>else</strong> <strong>if</strong> (matchedTemplate.equals(templates[2])) {
<a name="73" href="#73">73</a>           redirectURL = values.get(EntityView.PREFIX) + EntityView.SEPARATOR 
<a name="74" href="#74">74</a>              + values.get(EntityView.ID) + EntityView.PERIOD + Formats.XML;
<a name="75" href="#75">75</a>        }
<a name="76" href="#76">76</a>        <strong>return</strong> redirectURL;
<a name="77" href="#77">77</a>     }
<a name="78" href="#78">78</a>  
<a name="79" href="#79">79</a>     @EntityURLRedirect(<span class="string">"/{prefix}/going/nowhere"</span>)
<a name="80" href="#80">80</a>     <strong>public</strong> String returningRedirector(String incomingURL, Map&lt;String, String> values) {
<a name="81" href="#81">81</a>        <strong>return</strong> <span class="string">""</span>;
<a name="82" href="#82">82</a>     }
<a name="83" href="#83">83</a>  
<a name="84" href="#84">84</a>     @EntityURLRedirect(<span class="string">"/{prefix}/keep/moving"</span>)
<a name="85" href="#85">85</a>     <strong>public</strong> String neverRedirector(String incomingURL, Map&lt;String, String> values) {
<a name="86" href="#86">86</a>        <strong>return</strong> <strong>null</strong>;
<a name="87" href="#87">87</a>     }
<a name="88" href="#88">88</a>  
<a name="89" href="#89">89</a>  }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

